home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1999 April / Macworld (1999-04).dmg / Shareware World / Comms & Internet / Snak 2.0.1 / Scripts / README.ppk < prev    next >
Text File  |  1996-03-22  |  21KB  |  442 lines
  1. ------------------------------------------------------------------------------
  2. PurePak version 2.07 by Crypt Keeper [ckeeper@axiom.access.one.net]
  3.  
  4. This program is free software; you can redistribute it and/or modify
  5. it under the terms of the GNU General Public License as published by
  6. the Free Software Foundation; either version 1, or (at your option)
  7. any later version.
  8.  
  9. This program is distributed in the hope that it will be useful,
  10. but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12. GNU General Public License for more details.
  13.  
  14. You should have received a copy of the GNU General Public License
  15. along with this program; if not, write to the Free Software
  16. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17. ------------------------------------------------------------------------------
  18.  
  19. Files checklist... you should have the following:
  20.    README.ppk           - You are here
  21.    purepak.irc          - Main IRC script
  22.    purepak.hlp          - Help database
  23.    pp-bots.irc          - PurePak DCC RAW bots module
  24.    pp-kicks.irc         - PurePak Splatterkicks module
  25.    pp-dcc.irc           - PurePak DCC module
  26.    pp-silly.irc         - PurePak lame junk module
  27.  
  28. If you are missing any of these, mail ckeeper@axiom.access.one.net to get a
  29. full copy of the script.
  30.  
  31. ------------------------------------------------------------------------------
  32. Release notes for version 2.07:
  33. ------------------------------------------------------------------------------
  34.  
  35. This will probably be the last new version for a little while.  I am working
  36. on a larger project at the moment.
  37.  
  38. 2.07 is a minor bug fix in nick highlighting from 2.06
  39.  
  40. There is a version '2.08' going around.  This is a hack and probably has
  41. backdoors in it.
  42.  
  43. The ftp.ahbqs.com ftp site is no longer available and has been shut down
  44. for a long time.  There is a new mirror on ftp.connectnet.com, see the
  45. 'where can I get updates' section for more info.
  46.  
  47. I'm also having a problem accessing the ftp.access.digex.net site so
  48. that one may end up down too.
  49.  
  50. See the revision history for a list of changes in this version.
  51.  
  52. ------------------------------------------------------------------------------
  53. Table of Contents:
  54. ------------------------------------------------------------------------------
  55.  
  56.    I. Frequently Asked Questions (also look here for troubleshooting)
  57.   II. Where can I get updates to PurePak?
  58.  III. How can I un-clutter my directory of all these purepak files? 
  59.   IV. What to do if you have a suggestion or have found a bug
  60.    V. PurePak revision history
  61.  
  62. ------------------------------------------------------------------------------
  63. I. Frequently Asked Questions (and troubleshooting)
  64. ------------------------------------------------------------------------------
  65.  
  66. Q: How do I join a channel?  What is IRC?  How do I signoff?  What
  67.    is a script?  What is a server? ...etc..
  68. A: You should familiarize yourself with IRC before you try to use
  69.    an IRC script.  Try typing '/join #irchelp'
  70.  
  71. Q: What is this thing?
  72. A: It's an IRC script.  It runs under the ircII Internet Relay Chat
  73.    client, adds commands to it, and makes it generally easier to use.
  74.    You can get a copy of the ircII client by anonymous ftp to
  75.    cs-pub.bu.edu.  This script has only been tested under the Unix
  76.    version, but it has been reported to work under WinIrcII and
  77.    perhaps OS/2.  You must have an ircII script compatable client to
  78.    use it (at least version 2.2.9).
  79.  
  80. Q: How do I load this?
  81. A: Type '/load purepak.irc' from inside IRC.  If you get file not
  82.    found error, make sure you and purepak.irc and all of it's files
  83.    are in the right directory.  Also, if you got it in .ZIP format,
  84.    make sure that the filenames are in lower case if you are under
  85.    Unix!  On my system, you can give the unzip program a -L option
  86.    to make it extract filenames in lower case.  Unix filenames are
  87.    case-sensitive.
  88.  
  89. Q: What are pp-kicks.irc, pp-bots.irc, etc. scripts?
  90. A: These are the add-on scripts that can be loaded after purepak.irc.
  91.    They depend on purepak.irc and won't work without it.  You can load
  92.    them manually as you need them with /load, or you can set them to
  93.    auto-load on startup (/pphelp settings).
  94.  
  95. Q: What is purepak.hlp?
  96. A: This is the help database.  It is a script, but you shouldn't load
  97.    it manually.  It is auto-loaded on demand the first time you use
  98.    /pphelp.  It must be in a place where PurePak can find it or you
  99.    won't get any help.
  100.  
  101. Q: What is the PurePak equivalent of /setaway and /noaway?
  102. A: Just use /away as you normally would without a script.  /away <away msg>
  103.    to set away, and just /away with no parameters to come back.
  104.  
  105. Q: Where is /talkto and /endtalk?
  106. A: Those were just aliases to IRC's /query command.  /help query
  107.  
  108. Q: I am using the EPIC IRC client or another hacked/alternative client
  109.    and am having problems.
  110. A: I can't guarantee that the script will work flawlessly on hacked or
  111.    alternative clients.  The script has only been tested on unhacked
  112.    clients.  Anonymous ftp to cs-pub.bu.edu to get an unhacked client.
  113.    Common problems include: DCC RAW bots don't work, /net doesn't work,
  114.    /sve doesn't work, wierd messages, segmentation faults when using
  115.    complicated routines like /bot massdeop, etc.
  116.  
  117. Q: I get an error about the script being unable to determine my home
  118.    directory when I use /sve
  119. A: E-Mail me: what version of the script you're running, what version
  120.    of the client, and what type of system.  The script and client version
  121.    can be retrieved by typing "/version", and typing "uname -a" at your
  122.    system prompt will usually tell you what type of system you're on.
  123.  
  124. Q: I am using /window commands or /net and many things (such as protections)
  125.    don't work right, or messages appear in the wrong window.
  126. A: Two problems: 1) The script wasn't written with multiple-window support
  127.    in mind, and 2) The IRC client's multiple window support is not that
  128.    great.  The best thing to do is to see if you have a program installed
  129.    on your system called "screen" which will allow you to run multiple
  130.    copies of the irc client and any other program in different "windows."
  131.    I have found that ircII version 2.2.9 appears to work the best for multiple
  132.    windows, but it is an old version and has a few other bugs.
  133.  
  134. Q: I'm using an EPIC client and DCC bots don't work.
  135. A: As far as I can see, $connect() is broken (or purposefully disabled?)
  136.    on the latest EPIC client.  Get the plain irc client to use the bots.
  137.  
  138. Q: /users and/or /fmdop don't work right or don't work at all.
  139. A: Get a newer client.  They don't work at all on very old (2.2.9) clients
  140.    and may not be reliable on others due to bugs in raw_irc and ischanop().
  141.    The latest client is recommended.  Anonymous ftp to cs-pub.bu.edu.
  142.  
  143. Q: PurePak causes the client to 'segmentation fault' when it is loading.
  144. A: See the next Q: if you are using your client with the -d switch.  Else,
  145.    the best solution is to upgrade your client.  Get the latest ircII
  146.    client from anonymous ftp to cs-pub.bu.edu.
  147.  
  148. Q: I am using my IRC client with the -d option (dumb terminal mode)
  149.    and strange things happen.
  150. A: The script should work in dumb terminal mode, but using it with
  151.    the -d option isn't recommended.  It can produce strange results
  152.    as the script often uses inverse/bold control codes.  Some old
  153.    2.2.9 clients will crash in dumb terminal mode with scripts that
  154.    mess with the status line or control codes.
  155.  
  156. Q: I get a whole huge flood of stuff about ONs and ALIASes being
  157.    added when I load the script.  What's wrong?
  158. A: For some reason, your client is loading the script with the
  159.    display setting on.  I have never personally seen this, but
  160.    one user of TextBox reported it.  You could try putting the
  161.    following in your .ircrc:
  162.       ^set display off
  163.       load purepak.irc
  164.       ^set display on
  165.    The best solution would be to anonymous ftp to cs-pub.bu.edu
  166.    and upgrade your client to the latest version, or ask your
  167.    system administrator if the client is installed on the system.
  168.  
  169. Q: I load it and I get a message about my "TTY" environment variable
  170.    not being set.  How do I fix this?
  171. A: Put a line into your .login or .bash_login file (or some other
  172.    file that is auto-loaded) to set the TTY environment variable to
  173.    your current TTY.  Examples:
  174.      setenv TTY "$tty"            (for csh/tcsh)
  175.      export TTY="$(tty)"          (bash)
  176.    If you can't get this variable set, the /unflash command will not
  177.    work.  If you don't see the error, don't worry about it.  You
  178.    either already have the TTY variable set or you have an IRC client
  179.    version that doesn't need this.
  180.  
  181. Q: What is that number after the user status flags in my /who display?
  182. A: That is the distance of the user from you in server-to-server "hops."
  183.    This has nothing to do with physical distance, it is the number of
  184.    servers between you and the other person.
  185.  
  186. Q: Where is pp-war.irc?  It's mentioned in the script and in the help
  187.    but I don't have it.
  188. A: It isn't available as part of the archive.  I only give this out to
  189.    certain people.
  190.  
  191. Q: What is a "netsplit"?
  192. A: This is in the IRC faq I think, but I guess I'll answer it here
  193.    so I don't get a box full of e-mail...  A netsplit is when two
  194.    servers disconnect from each other, and users on one side of
  195.    the network see users from the other signoff, and vice versa.
  196.    The signoffs look like this:
  197.      *** Signoff: LAM3R (irc.someserver.edu irc.someserver.com)
  198.    These are the two servers that have disconnected from each other.
  199.  
  200. ------------------------------------------------------------------------------
  201. II. Where can I get updates to PurePak?
  202. ------------------------------------------------------------------------------
  203.  
  204. If you want continuous updates when they come out, the easiest thing
  205. to do is to sign up to the PurePak listserv.  To signon to the list,
  206. send a message (any message) to purepak@axiom.access.one.net (sending any
  207. message to this address causes you to be signed up).  Do not send any
  208. message that you want a human being to read to this address.  It is
  209. a list run by shell scripts.  If you have a question, or want to sign
  210. off of the PurePak list, e-mail ckeeper@axiom.access.one.net.
  211.  
  212. Other places to get a copy:
  213.  
  214. E-Mail ckeeper@axiom.access.one.net and just say 'gimme purepak' and I'll
  215. mail you a copy uuencoded/gzip'd/tar'd, or if you say you want it in
  216. pkzip format, I'll e-mail it to you uuencoded/zipped.
  217.  
  218. There may be a bot on IRC called 'PurePak'.  If it is online, and it is
  219. from axiom.access.one.net or shell.one.net, you could get the script from
  220. it.  Don't trust it if it is online from some strange place.
  221.  
  222. Anonymous ftp to:
  223.   ftp.access.digex.net         /pub/access/cdolphin/purepak
  224.   ftp.connectnet.com           /pub/irc/purepak
  225.   axiom.access.one.net         /pub/purepak   (primary site, part-time link)
  226.  
  227. You could ask me if you see me on IRC.  My nickname is 'CKeeper'.
  228. However, this is not the safest way to get the script as there is
  229. no nickname ownership on IRC and anyone could pose as me and hand
  230. out bugged/hacked copies of my script.  This happened several times
  231. with TextBox, so I discourage you from getting it this way.  If you
  232. would like to get it this way, /msg me 'xdcc list' to see if I am
  233. offering.
  234.  
  235. ------------------------------------------------------------------------------
  236. III. How do I un-clutter my directory of all these PurePak files?
  237. ------------------------------------------------------------------------------
  238.  
  239. Create a directory off of your home directory (the directory you are
  240. in when you log in, duh) called "purepak" and move all this stuff
  241. into it.  Then, load PurePak by typing "/load ~/purepak/purepak.irc"
  242. and don't worry about the other files.  PurePak will automaticly add
  243. ~/purepak to the script load path and will find the rest of it's
  244. modules and stuff just fine.
  245.  
  246. The ~ is expaneded to your home directory.
  247.  
  248. If you don't want to type out the /load every time you run IRC, put
  249. the line "/load ~/purepak/purepak.irc" in your ~/.ircrc file.
  250.  
  251. ------------------------------------------------------------------------------
  252. IV. What do I do if I have a suggestion or have found a bug?
  253. ------------------------------------------------------------------------------
  254.  
  255. If you have a suggestion or have found a bug (there are almost
  256. certainly bugs), send e-mail to me with a **DESCRIPTION** of the
  257. suggestion or bug.  E-Mail me at ckeeper@axiom.access.one.net.
  258.  
  259. Do not send me things like "/mdop doesn't work"; if you have found
  260. a bug, tell me what you were doing when the bug occured, what
  261. happened, and what client version you were using (/version to get
  262. this).  For suggestions, don't send me stuff like "add /wall",
  263. since I don't have every single IRC script ever made and
  264. I don't automaticly know what the command you're asking for is
  265. supposed to do.  Describe it!
  266.  
  267. Please don't /msg me on IRC about suggestions or bugs.  I am very
  268. likely to forget something I see flash by my screen in a message.
  269. Mail is saved in a folder so I can look back at it later.
  270.  
  271. ------------------------------------------------------------------------------
  272. V. PurePak revision history
  273. ------------------------------------------------------------------------------
  274.  
  275. 1.00a - First alpha test release, released to a few people
  276.    * Fixed the bug reported by many users that caused them to get
  277.      a "purepak.irc file not found" error.  If you are still seeing
  278.      this when you type "/load purepak.irc", there is a serious
  279.      problem on your end. :)
  280.  
  281. 1.00b - First public release
  282.    * Decided to add pp-kicks.irc
  283.    * Put it under the GNU General Public License... some people
  284.      actually mailed me about licensing back when I was writing
  285.      TextBox so that should fix that.
  286.  
  287. 1.01 - 
  288.    * You should not get any more 'unable to determine hostname' errors
  289.    * Bots now set themselves +i (invisible user mode)
  290.    * Setting of the IRC 'shell' variable is now saved by /sve
  291.    * Fixed a couple small bugs in pp-bots.irc
  292.    * Added /kradwrite and /kradsay to pp-silly.irc
  293.    * Added /wordkick
  294.    * DCCs are now logged while away
  295.    * Away "your message has been logged" notices now only sent to the
  296.      same nick once in every 2 minutes (and the message is now "your
  297.      messages are being logged")
  298.    * Auto-ignore works if clonebots have lots of ~'s in their usernames.
  299.    * Added quick guardbot maker alias /gb to pp-bots.irc
  300.    * Added 'HELPUnload' toggle to /pp to switch automatic unloading
  301.      of help information.
  302.  
  303. 1.02-1.04 -
  304.    * Skipped these #'s because of a hacked version or two
  305.  
  306. 1.05 -
  307.    * Added some code to make certain server notices look better
  308.    * Added some desynch notification code (requires umode +s)
  309.    * Added /rwhois
  310.    * Added /bot massdeop
  311.    * Your clonebots are excluded from massdeop protection
  312.    * Auto-ignore ignores nick floods
  313.    * Other small improvments to flood protection
  314.  
  315. 1.06 -
  316.    * Message/notice format settings are now _fully_ customizable by typing
  317.      /pp mformat.  The only problem is that the code could be faster.
  318.    * Added /pp motd setting to show/hide server motd on startup
  319.    * Improvments to flood protection
  320.    * XDCC friends list autoget toggle (/xdcc friends) to toggle automatic
  321.      file receiving from people on friends list
  322.    * Added 'writemethod' setting (FAST,SLOW) to toggle how PurePak
  323.      writes it's .sav file.  Use SLOW if FAST doesn't work.
  324.    * Added "channel protection"
  325.    * Guardbots join all your channels automatically when created with /gb
  326.    * Added a simple "netsplit tracker", and the /whosplit command
  327.    * Fixed a few bugs in pp-bots.irc
  328.    * Inverse space floods are now detected in msgs/notices
  329.    * Improved the appearance of who lists, and added some highlighting
  330.      of important messages
  331.  
  332. 1.07 -
  333.    * /sve may work on many more systems now
  334.    * Timeout protection (so you don't timeout on idle-time-limited servers)
  335.      works better
  336.  
  337. 1.08 -
  338.    * Fixed the ping reply bug
  339.    * Script now suppresses those annoying "dgets timed out" messages that
  340.      some newer clients give you when you're using slower links such as
  341.      SLIP/PPP.  These messages are just warnings.
  342.    * Added PGUP/PGDN/HOME scrollback keys
  343.    * The time field in message formats doesn't print the date, only the time
  344.    * Added personal away messages
  345.  
  346. 1.09 -
  347.    * Fixed /notify nick removal bug
  348.    * New method of writing purepak.sav that should be very fast and work
  349.      on almost any system.  It does however create a new window for a moment.
  350.      It uses the IRC logging feature to write to the file.  Since nobody
  351.      uses a 2400bps modem anymore I don't think this will be a problem.
  352.    * /ban alias now inserts random ?'s into ban strings
  353.    * Idle timeout protection should now work on almost any idle timeout
  354.      protected server.  Mail me if it doesn't.
  355.    * New DCC server module: pp-dcc.irc (replaces XDCC)
  356.    * Added /nslookup and /pp lookjoin setting (the 'host' program must be
  357.      on your system)
  358.    * Should now work ok on EPIC clients
  359.    * /sve uses $open(),$write(),and $close() on EPIC clients
  360.    * More ASCII art in pp-silly.irc
  361.    * Added /pp nostartup (switches on/off suppression of script startups)
  362.    * Added [Lag: XX] indicator (server-to-client lag) to status line
  363.    * Added support for channel specific friends/enemies lists
  364.    * Added /rkick (random kick) to pp-silly.irc
  365.  
  366. 2.00 -
  367.    * Fixed a problem with lag indicator
  368.    * Fixed /ban bug that made it stop if there was a 0 in ban string
  369.    * Ban alias now handles IP addresses as ???.???.???.* since the order
  370.      of host.subdomain.domain is the opposite of hostnames
  371.    * Added /pp funkybans switch to toggle random ?'s in bans
  372.    * Added pack statistics display to dcc offer listings
  373.    * DCC note is saved with /dcc save
  374.    * DCC DOFFER command adjusts pack numbers so they remain continuous
  375.    * DCC server takes working directory into account
  376.    * Massdeop should work now on all EPIC clients
  377.  
  378. 2.01 -
  379.    * Fixed bugs with /dcc send and /dcc chat in pp-dcc.irc
  380.    * /dcc save and /dcc load defaults to purepak.dcc
  381.    * Someone typing 'xdcc' publicly in channel no longer sets off dcc server
  382.    * DCC send limits should now work
  383.    * Added DCC autosend timeouts (/dcc timeout)
  384.    * If you give a umask (N!U@H) to ban/unban it just does a +b/-b on it
  385.    * Added /dcc publist toggle to allow/disallow public CTCP XDCC LISTs
  386.    * Added send request queueing if all slots are full
  387.    * Fixed a really lame bug in /dcc notice
  388.    * Fixed bugs in /nslookup and lookup-on-join
  389.    * Added XDCC LSPACK /msg command
  390.  
  391. 2.02 -
  392.    * Added /users (fast who) command
  393.    * Auto rejoin on kick delays 2 seconds
  394.    * The timestamp sent when you join a channel is the time the topic was
  395.      set, not the time the channel was created
  396.    * Mass mode change aliases check to see if you are opped
  397.    * Added /fmdop (massdeop that uses /users records)
  398.    * Removed /lameban (usually got _you_ banned)
  399.    * DCC limits and timeouts should work ok on ircII 2.2.9
  400.    * Timestamps added to notify signon/signoff
  401.  
  402. 2.03 -
  403.    * /users bug fixes
  404.    * /users warns of inaccurate ischanop() or if a channel hasn't synced yet
  405.    * Cleaned up some stuff in pp-silly.irc
  406.    * Fixed more bugs in dcc send limits
  407.    * pp-dcc.irc contains code to ignore dcc sends and chats using priviledged
  408.      port numbers-- usually bombs that try to get you to chat with chargen
  409.      or something else that will flood your terminal
  410.  
  411. 2.04 -
  412.    * Clonebot usernames are more random
  413.    * Away notices tell the caller when you went away (away since ...)
  414.    * Added /dcc autochat (automatically get chats) switch
  415.    * DCC chats are also automatically gotten if friends list autoget is on
  416.      and the user is on your friends list
  417.    * Added "me" bot action command (like /me)
  418.    * Speed optimizations to formatted echo routine used when you get a msg
  419.    * Idle timeout prot shouldn't ever have any more problems with no such
  420.      nick/channel messages
  421.  
  422. 2.05 -
  423.    * /users should work now with multiple windows open
  424.    * Personal away notices should work with special characters in nicks
  425.    * /nick will work for networks with long nicks
  426.    * /users self-updates if you do a /who command
  427.  
  428. 2.06 -
  429.    * Added /pp beepsplit to toggle beeping on netsplits
  430.    * Added highlighting of public messages if someone mentions your name in
  431.      a channel
  432.    * Added /pp page switch to switch CTCP PAGE beep
  433.    * Added /pp tprint switch to toggle printing time every 10 minutes
  434.  
  435. 2.07 -
  436.    * Fixed CTCP ACTION bug in public nick highlighting
  437.    * Added /pp nickmatch <string> to set the match string... if it is set
  438.      to '.', then it matches your current nick.
  439.    * /users might behave just a little better :P
  440.  
  441. ------------------------------------------------------------------------------
  442.